Skip to content

feat(Timeline): add DescriptionTemplate parameter #5088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jan 10, 2025
Merged

feat(Timeline): add DescriptionTemplate parameter #5088

merged 3 commits into from
Jan 10, 2025

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 10, 2025 •
edited by sourcery-ai bot
Loading

add DescriptionTemplate parameter

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符；如果有关联 Issue 请在下方填写相关编号

Description

fixes #5087

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

New Features:

  • Added a DescriptionTemplate parameter to the Timeline component.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 10, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request introduces a new DescriptionTemplate parameter to the Timeline component. This parameter allows users to customize the rendering of the timeline item descriptions using a RenderFragment. The existing Description parameter is still supported and will be used if DescriptionTemplate is not provided.

Sequence diagram for Timeline description rendering

sequenceDiagram
    participant T as Timeline Component
    participant TI as TimelineItem
    T->>TI: Check DescriptionTemplate
    alt DescriptionTemplate exists
        TI-->>T: Render DescriptionTemplate
    else DescriptionTemplate is null
        TI-->>T: Return Description string
    end
Loading

File-Level Changes

Change Details Files
Added DescriptionTemplate parameter to TimelineItem component
  • Added a new property DescriptionTemplate of type RenderFragment to the TimelineItem class.
  • Added documentation for the new DescriptionTemplate property.
 src/BootstrapBlazor/Components/Timeline/TimelineItem.cs
Modified Timeline component to use DescriptionTemplate
  • Added a conditional check in the Timeline component to use the DescriptionTemplate if provided.
  • If DescriptionTemplate is not provided, the existing Description property is used.
 src/BootstrapBlazor/Components/Timeline/Timeline.razor
Added unit tests for DescriptionTemplate
  • Added a new unit test ItemDescriptionTemplate_Ok to verify the functionality of the DescriptionTemplate parameter.
  • The test renders a Timeline component with items that have both Description and DescriptionTemplate properties.
  • The test asserts that the DescriptionTemplate is used when provided.
 test/UnitTest/Components/TimelineTest.cs
Updated project file src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5087 Allow HTML elements to be displayed in the Description content of Timeline items ✅

Possibly linked issues

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the enhancement New feature or request label Jan 10, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 10, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) January 10, 2025 07:25
sourcery-ai[bot]
sourcery-ai bot approved these changes Jan 10, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Jan 10, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (a200c0f) to head (69d51fe).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main     #5088   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        28078     28084    +6     
  Branches      4034      4035    +1     
=========================================
+ Hits         28078     28084    +6

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang ArgoZhang merged commit 6f64911 into main Jan 10, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-timeline branch January 10, 2025 07:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] approved these changes

Assignees

@ArgoZhang ArgoZhang

Labels

enhancement New feature or request

Projects

None yet

Milestone

v9.2.0

Development

Successfully merging this pull request may close these issues.

feat(Timeline): Description 内容是否可以增加html元素显示

2 participants

@ArgoZhang